'<COMMAND> is the command name. Must be in all caps. An underscore in the command name maps to a space in the .HELP command. (.HELP TOPIC USERS, for example).
'<INDEX> is an index to the mainPrefs.al record that has the access level settings for ShadowBot. If <INDEX> is negative, then <INDEX> is the actual access level, otherwise it points to an access level in mainPrefs.com.
'If <INDEX> is "PLM" or "PLN", the access levels for partyline master or partyline owner are subsitituted.
'<NUMLINES> is the number of lines in the entry. When someone types .HELP <COMMAND>, the bot finds the offset of the first line of text and reads in <NUMLINES> of text.
'"HELP" denotes the start of an entry. Don't start a line beining with 'HELP' unless it's the begining of an entry.
'Each help entry takes approximately 40 bytes of RAM. You can create your own entries or modify or delete existing ones.
'One line of white space is not necessary between each entry, but it helps for clairity when manually viewing this file.
'The first line of text after the HELP command line is the argument line. This MUST NOT be counted in <NUMLINES>.
'END marks the end of the file. It is not parsed after this point.
HELP COMMANDS 0 13
List of all commands.
help topics: BASIC CHANNEL MISC USERS BOT MASS PARTYLINE (.HELP TOPIC <topicname>)
whom boot chat echo assoc link unlink away me who botinfo
HELP OP 1 1
[nick]
Ops the nick specified. If none specified, ops you.
HELP DEOP 2 1
[nick]
Deops the nick specified. If none specified, deops you.
HELP KICK 3 1
[nick]
Kicks the nick specified. If none specified, kicks you. (Also K)
HELP K 3 1
[nick]
Kicks the nick specified. If none specified, kicks you. (Also KICK)
HELP DIE 4 2
[reason]
Makes the bot write all files, signoff, and exit. Signs off with reason specified.
If no reason, exits with the reason "!die requested"
HELP QUIT 4 1
[reason]
Same as DIE.
HELP SAY 5 1
[channel] text
Speaks text into the channel.
HELP MSG 6 1
nick message
Sends nick a message.
HELP NOTICE 7 1
nick message
Sends nick a notice
HELP ME 8 1
[channel] action
Does an action on the current channel. If no channel specified, and you are on the partyline, the action is done on the partyline.
HELP TIME 9 1
[none]
Displays the time.
HELP SEEN 10 1
nick
Displays the last time nick was seen and how long ago that was.
HELP ADDUSER 11 3
CHANNEL nick userAtHost accessLevel [autoOp] [prot] [pwd]
Adds the user specified to the userlist. If no params past accessLevel are displayed, then they are set to off.
If autoop is T, Y, or 1, autoop is enabled.
Channel can either be a channel name or '*' (all of them). (Also ADD)
HELP DELETEUSER 12 1
channel mask
Deletes a user matching the mask given on the channel specified. (Also DEL)
HELP SAVEUSERS 13 1
[none]
Saves the userlist.
HELP SAVEPREFS 14 1
[none]
Saves the data files.
HELP SAVESHIT 15 1
[none]
Saves the shitlist.
HELP SAVEALL 16 1
[none]
Saves all files.
HELP USERLIST 17 1
[channel]
Displays the userlist. If a channel is specified, the listing is limited to that channel only.
HELP STATUS 18 1
[none]
Displays statistics about the bot. (Also STAT, STATS, BOTSTATS)
HELP SETACCESS 19 1
channel nick access
Changes a user in the userlist's access. You can not give someone more access than you have. (Also CLVL)
HELP SETAUTOOP 20 1
channel nick autoop
Changes a user's autoop setting. If yours isn't on, you can't change theirs. (Also CAUTO)
HELP ACCESS 21 1
nick
Views nick's access. If no nick is specified, your access is displayed.
HELP PING 22 1
[none]
Returns a pong response from the bot.
HELP PONG 22 1
[none]
Gag. Returns a ping respose from the bot.
HELP TOPIC 23 1
topic
Sets the topic of the channel.
HELP INFOLINE 24 1
[infoline]
Sets the text displayed when you join the channel. If you don't give an infoline, it displays yours.
HELP EMAIL 0 1
[emailAddress]
Sets your email address. If you don't give an address, it displays yours.
HELP IDLE 25 1
idleSeconds
Displays how long everyone the bot has seen is idle. If idleSeconds is present and greater than zero, displays those who have been idle longer than idleSeconds
HELP CHANGECC 26 1
newCC
Changes the bot's command character. (Also CC)
HELP PAGE 27 1
[none]
Pages the operator of the bot.
HELP UP 28 1
[none]
Ops you.
HELP DOWN 29 1
[none]
Deops you.
HELP BAN 30 1
nickOrMask
Bans, and then kicks, the mask of the nick passed to it, or the mask passed to it.
HELP B 30 1
nickOrMask
Same as BAN.
HELP UNBAN 31 1
nickOrMask
Unbans the nick or mask passed to it.
HELP UB 31 1
nickOrMask
Same as UNBAN.
HELP SHIT 32 4
channel nickOrMask shitLevel days [reason]
Shitlists the nick or mask passed to it for the number of days specified.
See .HELP SHITLEVEL for more information on the shitLevel parameter.
Reason sets the reason seen in the SHITLIST and when the user is kicked from the channel.
Channel can be either a channel or '*' (all of them).
HELP SHITLEVEL 0 6
/not a command/
SHITLEVEL =-1: automatic shitlist entry for flooding
SHITLEVEL = 0: the user is not shitlisted
SHITLEVEL = 1: the user is prevented from being opped
SHITLEVEL = 2: the user is kicked on entry.
SHITLEVEL = 3: the user is bankicked, unbanned five minutes later, and rebanned if he enters the channel;
SHITLEVEL = 4: the user is permabanned; if he is unbanned, he is rebanned.
HELP UNSHIT 33 1
channel nickOrMask
Removes a nick or mask from the shitlist for a specific channel. (Also RSHIT)
HELP SHITLIST 34 1
[channel]
Displays the shitlist. Limits the listing to a specific channel if one specified.
HELP DEAF 35 1
[none]
Executes a MODE +d (prevents the server from sending channel messages).
HELP HEAR 36 1
[none]
Executes a MODE -d (allows channel messages to be recieved).
HELP SLEEP 37 1
[none]
Causes the bot to go to sleep, ignoring all commands except AWAKE.
HELP AWAKE 38 1
[none]
Wakes the bot.
HELP COUNTRY 39 1
countryAbbrev
Displays the full country name for the abbreviation passed to it.
HELP PLUSV 40 1
[nick]
Executes MODE +v on a nick. If no nick specified, operates on you. (Also V, V+, +V)
HELP MINUSV 41 1
[nick]
Executes MODE -v on a nick. If no nick specified, operates on you. (Also V-, -V)
If you're not in DCC chat, this command makes ShadowBot DCC chat you.
If you are in DCC chat, this command is used to move you around in the party line.
"ON" - Join the Partyline. "OFF" - leave the partyline
<channel number> - Joins a channel in the range of 0 to 99999 (0 is the partyline)
<channel name> - Joins a channel with the specified name. Names can be set with the assoc commmand.
HELP SERVER 43 1
server [port]
Changes servers.
HELP MSHITLEVEL 44 1
channel nick|userAtHost newShitLevel
Changes a user's shitlevel on specifiec channel.
HELP MSHITDAYS 45 1
channel nick|userAtHost daysTillExpire
Changes the number of days until the shitlist entry expires on specified channel.
HELP MSHITREASON 46 1
nick|userAtHost newReason
Changes the shitlist reason.
HELP CYCLE 47 1
[seconds]
Causes the bot to leave the current channel and rejoin seconds later. If seconds is zero or not present, the bot rejoins immediately.
HELP JOIN 48 1
channel
Makes the bot join a channel.
HELP LEAVE 49 1
[channel]
Makes the bot leave the channel, or current channel if none given.
HELP CPING 50 1
[nick]
Pings someone and tells you the ping time. If no nick is specified, the bot pings you.
HELP INVITE 51 1
[nick]
Invites someone to the channel. If no nick is specified, invites you.
HELP SEND 52 2
[nick] filename
DCC SENDs a file to someone. The file must be in the DCC folder. If no nick is specified, the file is sent to the person who initiated the command.
HELP NICK 53 1
newnick
Changes the bot's nick.
HELP WHOIS 54 1
[nick]
Gives information on someone in the userlist.
HELP SETPROTECTION 55 1
nick protlevel
Changes someone's protection level. You cannot set it higher than your own. (Also CPROT)
HELP REV 56 1
text
Reverses the text in the string passed to it.
HELP SIGNOFF 60 1
[reason]
Disconnects the bot from the server.
HELP SIGN 60 1
[reason]
Same as SIGNOFF.
HELP IGNORE 61 1
/incomplete/
Do not use this command.
HELP RAW 62 1
rawIRC
Sends anything you pass to it directly to the servr as-is.
HELP MODE 63 1
channel rawMode
Does raw mode changes.
HELP LISTOPS 65 1
channel
Lists the ops on the channel specified.
HELP LISTV 66 1
channel
Lists users that are +v on the channel specified.
HELP MASSOP 67 1
[channel] mask
Massops anyone on the channel matching the mask and not in the shitlist with a shitlevel > 0.
HELP MOP 67 1
[channel] mask
Massops anyone on the channel matching the mask and not in the shitlist with a shitlevel > 0.
HELP MASSDEOP 68 1
[channel] mask
Deops anyone on the channel matching the mask and not protected in the userlist.
HELP MDEOP 68 1
[channel] mask
Deops anyone on the channel matching the mask and not protected in the userlist.
HELP MASSKICK 69 1
[channel] mask
Kicks anyone in the channel mathcing the mask who doesn't have a protectlevel > 1.
HELP MK 69 1
[channel] mask
Kicks anyone in the channel mathcing the mask who doesn't have a protectlevel > 1.
HELP MASSV 70 1
[channel] mask
MODE +v's everyone on the channel matching the mask. (Also MV, MV+)
HELP MASSV- 71 1
[channel] mask
MODE -v's anyone on the channel matching the mask. (Also MV-)
HELP SPY 72 1
channel
Enables spy mode for the channel specified. Allows you to see what happens on a channel the bot's in without you actually having to be in it.
HELP CTCP 73 1
text
Initiates the CTCP command specified.
HELP LOG 0 2
[channel] logCommand
This command allows you to change the log settings. Type ".HELP LOG command" for more information.
Valid commands are: ON, OFF, STATS, MARK. If no command is passed, STATS is assumed.
HELP LOG_ON 74 1
LOG [channel] ON
Turns logging on for the channel specified.
HELP LOG_OFF 75 1
LOG [channel] OFF
Turns logging off.
HELP LOG_STATS 76 1
LOG [channel] STATS
Gives the status of logging and the size of the log file.
HELP LOG_MARK 77 1
LOG [channel] MARK text
Makes a mark in the channel's log file.
HELP ADDLIST 78 1
filename tag string
Adds an entry to a list plugin file.
HELP BANLIST 79 1
[channel]
Lists all active bans on a channel.
HELP ADDUSERHOST 80 1
[nick] userhost
Adds a userhost to the specified nick, or yourself if no nick specified.
HELP DELUSERHOST 82 1
[nick] userhost
Removes a userhost to the specified nick, or yourself if no nick specified.
HELP AUTOVOICE 84 1
[channel] nick true|false
Sets someone's autovoice setting.
HELP SETAUTOJOIN 85 2
[channel] [true]
Sets a channel's autojoin setting. If the first character of the parameters after a channel specifier is not 'T', autojoin for the channel is set to false.
You can only set the autojoin setting on channels in the Channels Manager.
HELP LISTPLUGINS 86 1
[none]
Displays all commands installed by plugins.
HELP LISTDCC 87 1
[none]
Lists all active DCC connections.
HELP KILLDCC 88 1
nickname
Kills the dcc connection belonging to nickname.
'PARTYLINE
HELP WHOM 0 1
[channel]
Lists the people in the partyline. If you have masters, you can specify the channel to list.
HELP BOOT PLM 1
nick[@bot] [reason]
Boots a person off the partyline.
HELP ECHO 0 1
["ON" | "OFF"]
Displays the state of your text echo, or turns it on and off.
HELP ASSOC 0 1
[channel [topic]]
With no arguments, .ASSOC displays a list of all associations. With one argument (e.g. ".ASSOC 42"), it erases the topic for that channel. With two arguments (e.g. ".ASSOC 42 New Topic"), it sets (or changes) the topic of the channel to whatever you want.
HELP LINK PLM 1
[none]
Connects ShadowBot to the botnet set up in the BotNet Configuration.
HELP UNLINK PLM 1
[none]
Disconnects ShadowBot from the botnet.
HELP AWAY 0 1
[reason]
Marks you as being away. If no reason is given, marks you as being not away.
HELP WHO 0 1
bot
Displays information about a specific bot.
HELP BOTINFO 0 1
[none]
Displays information about bots on the botnet.
HELP NOTE 0 1
nick message
Sends a note to the specified nick.
HELP NOTES 0 5
[command]
Allows you to send notes to other people. Valid commands are:
index - lists all your notes. Default if no command is given.
read num - reads note #num.
erase num - erases note #num. You can use 'erase ALL' to erase all notes.
send nick message - same as the NOTE command.
HELP RSPY 0 1
channel
Removes a spy on the channel specified.
HELP IDENT 0 1
[nick] password
Allows the bot to recognize you if you have a password. Put a nick first if you want to gain access if you're not using your normal nick.
HELP NEWPASS 0 2
oldPassword newPassword [needPw]
Changes your password. Pass 1 for needPw if you want the password required, otherwise set it to zero.
Set your password to 'NONE' to clear it. (Also PASS, PWD)
HELP MOTD 0 1
(no arguments)
Displays the bot's MOTD. Requires DCC.
HELP HELP 0 1
command
Displays help on a command. Type ".HELP TOPICS" for a list of topics, or ".HELP COMMANDS" for a list of commands.
